home *** CD-ROM | disk | FTP | other *** search
/ Complete Linux / Complete Linux.iso / docs / apps / database / postgres / postgre2.z / postgre2 / ref / unix / shmemdoc < prev    next >
Encoding:
Text File  |  1992-08-27  |  4.0 KB  |  158 lines
  1. .\" $Header: /private/postgres/ref/unix/RCS/shmemdoc,v 1.2 1992/08/18 18:14:52 mao Exp $
  2. .SP SHMEMDOC UNIX 8/11/92
  3. .uh NAME
  4. .lp
  5. shmemdoc \- \*(PP shared memory doctor
  6. .uh SYNOPSIS
  7. .ip
  8. .b shmemdoc
  9. [
  10. .i "\-p port"
  11. ] [
  12. .i "\-B nbuffers"
  13. ]
  14. .uh DESCRIPTION
  15. .lp
  16. The
  17. .b shmemdoc
  18. program understands the layout of \*(PP data in shared memory,
  19. and can be used to examine shared structures.
  20. This program is intended only for debugging \*(PP,
  21. and should not be used in normal operation.
  22. .lp
  23. When some backend dies abnormally,
  24. the postmaster normally reinitializes shared memory and semaphores,
  25. and forces all peers of the dead backend to exit.
  26. If the postmaster is started with the \fI\-n\fP flag,
  27. then shared memory will not be reinitialized,
  28. and
  29. .b shmemdoc
  30. can be used to examine shared state after the crash.
  31. .lp
  32. A simple command interpreter reads user commands from standard
  33. input and prints results on standard output.
  34. The available commands,
  35. and their actions,
  36. are:
  37. .ip "\fBsemstat\fP"
  38. Show the status of system semaphores.
  39. Status includes semaphore names and values,
  40. the process id of the last process to change each semaphore,
  41. and a count of processes sleeping on each semaphore.
  42. .ip "\fBsemset\fP \fIn\fP \fIval\fP"
  43. Set the value of semaphore number \fIn\fP (with zero being the first semaphore
  44. named by
  45. .b semstat )
  46. to
  47. .i val .
  48. This is really only useful for resetting system state maually after a crash,
  49. and you don't want to do it.
  50. .ip "\fBbufdescs\fP"
  51. Print the contents of the shared buffer descriptor table.
  52. .ip "\fBbufdesc\fP \fIn\fP"
  53. Print the shared buffer descriptor table entry for buffer
  54. .i n .
  55. .ip "\fBbuffer\fP \fIn\fP \fItype\fP \fIlevel\fP"
  56. Print the contents of buffer number
  57. .i n
  58. in the shared buffer table.
  59. The buffer is interpreted as a page from a
  60. .i type
  61. relation,
  62. where
  63. .i type
  64. may be
  65. .i heap ,
  66. .i btree ,
  67. or
  68. .i rtree .
  69. The
  70. .i level
  71. argument controls the amount of detail presented.
  72. Level zero prints only page headers,
  73. level one prints page headers and line pointer tables,
  74. and level two (or higher) prints headers,
  75. line pointer tables,
  76. and tuples.
  77. .ip "\fBlinp\fP \fIn\fP \fIwhich\fP"
  78. Print line pointer table entry
  79. .i which
  80. of buffer
  81. .i n .
  82. .ip "\fBtuple\fP \fIn\fP \fItype\fP \fIwhich\fP"
  83. Print tuple
  84. .i which
  85. of buffer
  86. .i n .
  87. The buffer is interpreted as a page from a
  88. .i type
  89. relation,
  90. where
  91. .i type
  92. may be
  93. .i heap ,
  94. .i btree ,
  95. or
  96. .i rtree .
  97. .ip "\fBsetbase\fP \fIptr\fP"
  98. Set the logical base address of shared memory for
  99. .i shmemdoc
  100. to
  101. .i ptr .
  102. Normally,
  103. .i shmemdoc
  104. uses the address of each structure in its own address space
  105. when interpreting commands and printing results.
  106. If
  107. .i setbase
  108. is used,
  109. then on input and output,
  110. addresses are translated so that the shared memory segment appears
  111. to start at address
  112. .i ptr .
  113. .ip
  114. This is useful when a debugger is examining a core file produced by
  115. \*(PP and you want to use the shared memory addresses that appear
  116. in the core file.
  117. The base of shared memory in \*(PP is stored in the variable
  118. .i ShmemBase ,
  119. which may be examined by a debugger.
  120. .ip
  121. .i Ptr
  122. may be expressed in octal (leading zero),
  123. decimal,
  124. or hexadecimal
  125. (leading 0x).
  126. .ip "\fBshmemstat\fP"
  127. Print shared memory layout and allocation statistics.
  128. .ip "\fBwhatis\fP \fIptr\P"
  129. Identify the shared memory structure pointed at by
  130. .i ptr .
  131. .ip \fBhelp\fP
  132. Print a brief command summary.
  133. .ip \fBquit\fP
  134. Exit
  135. .i shmemdoc .
  136. .uh ARGUMENTS
  137. .ip "\fI\-B nbuffers\fP"
  138. The number of buffers used by the backend.
  139. This value is ignored in the present implementation of
  140. .i shmemdoc ,
  141. but is important if you choose to change the number
  142. allocated by \*(PP.
  143. In that case,
  144. you're out of luck for now.
  145. .ip "\fI\-p port\fP"
  146. The port on which the postmaster was listening.
  147. This value is used to compute the shared memory key used by the
  148. postmaster when shared memory was initialized.
  149. .uh BUGS
  150. .lp
  151. Probably doesn't work on anything but DECstations.
  152. .lp
  153. All of the sizes, offsets, and values for shared data are hardwired
  154. into this program;
  155. it shares no code with the ordinary \*(PP system,
  156. so changes to shared memory layout will require changes to this program,
  157. as well.
  158.